Inactivate Recipient Record

Flags a particular version of the recipient's demographic information as 'inactive', meaning it will not be considered when processing claims for the time period when that record would have been 'effective'. The version will still exist, it will just be ignored. Note that there must remain at least one active version of the recipient record. Attempts to inactivate the last version will fail.

Inactivation is final. However, a 'copy' of a previously inactivated record can be created by performing an Update Recipient

Mechanism

POST [base]/Patient/[ODBNumber]/$deactivateRecipient?_version=[version timestamp]

Payload	Example
In: No payload. Search parameter specifying the _version, which corresponds to Patient.meta.version of the version to inactivate
Out (success): HTTP 200 with no extra headers, Warning Operation Outcome (optional)
Out (error): HTTP 4xx or 5xx Operation Outcome (optional)